package com.sq.shortlink.admin.service;

import com.baomidou.mybatisplus.extension.service.IService;
import com.sq.shortlink.admin.dao.entity.UserDO;
import com.sq.shortlink.admin.dto.req.UserLoginReqDTO;
import com.sq.shortlink.admin.dto.req.UserRegisterReqDTO;
import com.sq.shortlink.admin.dto.req.UserUpdateReqDTO;
import com.sq.shortlink.admin.dto.resp.UserActualRepDTO;
import com.sq.shortlink.admin.dto.resp.UserLoginRespDTO;
import com.sq.shortlink.admin.dto.resp.UserRepDTO;

/**
 * 用户接口层
 * @author quan
 */
public interface UserService extends IService<UserDO> {
    /**
     * 根据用户名查询未脱敏用户信息
     * @param username 用户名
     * @return 未脱敏用户信息
     */
    UserActualRepDTO getActualUserByUsername(String username);

    /**
     * 根据用户名查询脱敏用户信息
     * @param username 用户名
     * @return 脱敏用户信息
     */
    UserRepDTO getUserByUsername(String username);

    /**
     * 查询用户名是否可用
     * @param username 用户名
     * @return 可用返回 True 不可用返回False
     */
    Boolean hasUsername(String username);

    /**
     * 用户注册
     * @param requestParam 用户注册请求参数
     */
    void register(UserRegisterReqDTO requestParam);

    /**
     * 用户登录
     * @param requestParam 用户登录请求参数
     * @return 用户登录响应结果
     */
    UserLoginRespDTO login(UserLoginReqDTO requestParam);

    /**
     * 检查用户是否登录
     * @param username 用户名
     * @param token 用户Token
     * @return 用户登录标识 登录返回 True 未登录 返回 False
     */
    Boolean checkLogin(String username, String token);

    /**
     * 用户退出登录
     * @param username 用户名
     * @param token 用户Token
     */
    void logout(String username, String token);

    /**
     * 根据用户名修改用户
     * @param requestParam 用户修改请求参数
     */
    void update(UserUpdateReqDTO requestParam);
}
